设置数据库表名

setTableName('数据库表名')

版本更新内容
1.0.7支持使用模型

默认情况下,批量操作或者右侧的启用、禁用,其他快捷操作会去修改”当前模块名_当前控制器名“的数据表,如果需要额外指定,可以使用setTableName方法。

  1. // 使用ZBuilder快速创建数据表格
  2. return ZBuilder::make('table')
  3. ->setTableName('admin_user') // 指定数据表名
  4. ->fetch(); // 渲染页面

注意:数据表名无需填写表前缀

使用模型

默认情况下,“启用”、“禁用”、“快速编辑”等默认操作,都是使用Db类来操作数据。从1.0.7版本开始,支持使用自定义模型来操作数据。

以角色管理控制器为例,路径为:application\user\admin\Role.php

即,模块为user,控制器为role,要操作的表为admin_role,默认我们创建表格是这样写的

  1. public function index()
  2. {
  3. // 获取查询条件
  4. $map = $this->getMap();
  5. // 数据列表
  6. $data_list = RoleModel::where($map)->paginate();
  7. // 使用ZBuilder快速创建数据表格
  8. return ZBuilder::make('table')
  9. ->setTableName('admin_role') // 设置表名
  10. ->setSearch(['name' => '角色名称', 'id' => 'ID']) // 设置搜索参数
  11. ->addColumns([ // 批量添加列
  12. ['id', 'ID'],
  13. ['name', '角色名称'],
  14. ['description', '描述'],
  15. ['create_time', '创建时间', 'datetime'],
  16. ['access', '是否可登录后台', 'switch'],
  17. ['status', '状态', 'switch'],
  18. ['right_button', '操作', 'btn']
  19. ])
  20. ->addTopButtons('add,enable,disable,delete') // 批量添加顶部按钮
  21. ->addRightButtons('edit,delete') // 批量添加右侧按钮
  22. ->setRowList($data_list) // 设置表格数据
  23. ->fetch(); // 渲染模板
  24. }

因为模块为user,控制器为role,而我们要操作的表不是user_role而是admin_role,所以我们需要用setTableName()方法来设置正确的表名。

这里我们无论是使用快速编辑还是删除、禁用、启用,都是用Db类来操作数据的。

如果希望用模型来操作数据,那可以这样写:

  1. ->setTableName(true)

表名设置为true,则框架会优先实例化“当前模块名/当前控制器名”这个模型,如上面的会实例化user模块下role模型(即application\user\model\Role.php这个文件)。

如果想指定模型,可直接输入模型参数,并且setTableName的第二个参数设置为true,如:

  1. ->setTableName('role', true)

这样表示使用model('user/role')来处理,如果不指定模块,则默认是当前模块。

也可以指定完整的模型类,如:

  1. ->setTableName('admin/role', true)

表示使用model('admin/role')来处理数据。

除了可以设置第二个参数为true之外,也可以设置0,1,2三种中的一种

参数含义
0表示使用Db::table()实例化(不加表前缀)
1默认类型,表示使用Db::name()实例化(自动加表前缀)
2表示使用model()实例化
true表示使用model()实例化,作用和参数2相同
  1. ->setTableName('role', 0) // 表示使用Db::table('role')
  1. ->setTableName('role', 1) // 表示使用Db::name('role')
  1. ->setTableName('role', 2) // 表示使用model('user/role')
  1. ->setTableName('admin/role', 2) // 表示使用model('admin/role')

等同于

  1. ->setTableName('admin/role', true) // 表示使用model('admin/role')

需要注意的地方

setTableName方法虽然可以设置使用哪种方式来操作数据,但它的作用是可以被addRightButton或者addTopButton方法所覆盖的。

  1. // 使用ZBuilder快速创建数据表格
  2. return ZBuilder::make('table')
  3. ->setTableName('admin_role') // 设置表名
  4. ->addRightButton('delete') // 批量添加右侧按钮
  5. ->fetch(); // 渲染模板

这种情况下,默认是使用Db::name('admin_role')来操作数据的。

如果我们在添加右侧按钮的时候,指定了表名,则优先使用右侧按钮参数所设置的类型。

  1. // 使用ZBuilder快速创建数据表格
  2. return ZBuilder::make('table')
  3. ->setTableName('role', true) // 设置表名
  4. ->addRightButton('delete', ['table' => 'admin_role']) // 批量添加右侧按钮
  5. ->fetch(); // 渲染模板

我们可以看到,虽然上面使用了->setTableName('role', true)指定使用实例化模型方式操作数据,但右侧按钮的删除指定了表名,则删除按钮的时候,默认还是会使用Db::name('admin_role')来操作数据。

当然,也可以指定其他类型,如:

  1. // 使用ZBuilder快速创建数据表格
  2. return ZBuilder::make('table')
  3. ->setTableName('role', true) // 设置表名
  4. ->addRightButton('delete', ['table' => 'admin_role', 'prefix' => 0]) // 批量添加右侧按钮
  5. ->fetch(); // 渲染模板

点击删除按钮时,使用Db::table('admin_role')来操作数据。

即,如果添加右侧按钮,或者顶部按钮时,指定了表名,则会忽略setTableName方法所设置的内容。

注意,当添加右侧或顶部按钮时,指定了表名,没有指定prefix参数时,setTableName方法的位置会影响实际的操作类型。

  1. // 使用ZBuilder快速创建数据表格
  2. return ZBuilder::make('table')
  3. ->setTableName('role', true) // 设置表名
  4. ->addRightButton('delete', ['table' => 'admin_role']) // 批量添加右侧按钮
  5. ->fetch(); // 渲染模板

这样写法,表示删除按钮使用model('user/admin_role')来操作数据,因为setTableName先执行,它设置了操作模式为模型方式,而addRightButton方法没有指定prefix参数,则会使用setTableName方法所指定的类型操作。但如果setTableName方法放在添加按钮的后面,则效果就不一样了。

  1. // 使用ZBuilder快速创建数据表格
  2. return ZBuilder::make('table')
  3. ->addRightButton('delete', ['table' => 'admin_role']) // 批量添加右侧按钮
  4. ->setTableName('role', true) // 设置表名
  5. ->fetch(); // 渲染模板

表示使用Db::name('admin_role')来操作数据,因为在生成按钮时, setTableName方法还未执行,所以就使用了默认的操作类型。